Runtime feature detection #13549

larroy · 2018-12-05T17:50:05Z

Description

It would be good to have runtime feature detection, for example to know if we were compiled with OPENCV, LAPACK, some tests fail when MXNet is not compiled with some feature or another.

This is a proposal for a runtime feature detection mechanism that would expose how the library was compiled and what features are available.

It also grooms some of the feature flags which were not uniformly set in base.h

See related discussion in dev:

https://lists.apache.org/thread.html/19fe1da67551f9a199ec85dbb9c894e65c205d5fdd6764509e6e41ed@%3Cdev.mxnet.apache.org%3E

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
Changes are complete (i.e. I finished coding on this PR)
All changes have test coverage:
Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
Code is well-documented:
For user-facing API changes, API doc string has been updated.
For new C++ functions in header files, their functionalities and arguments are documented.
For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

Feature1, tests, (and when applicable, API doc)
Feature2, tests, (and when applicable, API doc)

Comments

If this change is a backward incompatible change, why must this change be made.
Interesting edge cases to note here

Roshrini · 2018-12-18T02:40:26Z

@larroy Thanks for working on this. Is this PR ready to review or still WIP?
@leleamol @anirudh2290 Can you review this PR?

larroy · 2018-12-18T11:36:56Z

It's WIP. I'm taking a few days off. Will get back to this after my break.

Roshrini · 2019-01-03T18:11:08Z

@mxnet-label-bot Update [pr-work-in-progress]

src/mxfeatures.cc

stsukrov · 2019-01-07T14:51:12Z

src/mxfeatures.cc

+class Storage {
+public:
+    Storage():
+        feature_bits()


Will feature_bits be initialized without explicit init?

Yes, still better to initialize members explicitly for consistency in C++

src/mxfeatures.cc

stsukrov · 2019-01-07T14:53:57Z

src/mxfeatures.cc

+        feature_bits.set(JEMALLOC);
+#endif
+    }
+    bool is_enabled(unsigned feat) {


NIT: const?

NIT: Consistency with enum type?

can't because of higher level language ergonomics.

src/mxfeatures.cc

include/mxnet/mxfeatures.h

lebeg · 2019-01-07T16:40:01Z

You could add the dev lists discussion link to the description.

src/mxfeatures.cc

include/mxnet/mxfeatures.h

pengzhao-intel · 2019-01-08T12:36:38Z

Thanks for the PR. It's a very useful proposal and improvement.
With these piece of information, I think we can enable more backend specific features in the runtime.
@ZhennanQin

include/mxnet/mxfeatures.h

larroy · 2019-01-09T01:09:39Z

@mxnet-label-bot Update [pr-awaiting-review]

larroy · 2019-01-09T16:52:35Z

@stsukrov not sure what you mean.

…n API

larroy · 2019-01-17T13:15:04Z

@mxnet-label-bot update [pr-awaiting-merge]

aaronmarkham

Can you provide usage details? Maybe example inputs and outputs of running it?

larroy · 2019-01-18T15:02:37Z

@aaronmarkham where would you suggest to add this? you mean as a documentation? The unit tests show how to use it. We need to build on top of this feature for selecting tests at runtime, so there will be more usage examples.

aaronmarkham · 2019-01-18T17:21:37Z

I could have just randomly tried executing the scripts but I wanted to know, in advance, what should be run to make them work and what to expect to see if they did work. Then I'd know if it didn't work, or if it did.

larroy · 2019-01-18T19:45:30Z

Did you see the provided unit test?

python/mxnet/mxfeatures.py

* Prototype for runtime feature detection * Includes from diamond to quotes * Add CPU feature and BLAS flavour flags * Add BLAS flavour and CPU SSE and AVX flags * MXNET_USE_LAPACK * Fix C++ linting errors * Expose runtime feature detection in the public C API and in the Python API * Refactor Storage -> FeatureSet * Refine documentation * Add failure case * Fix pylint * Address CR comments

larroy requested review from anirudh2290 and szha as code owners December 5, 2018 17:50

larroy force-pushed the feature_discovery branch from 3aa46a4 to 3eac26d Compare December 5, 2018 17:56

nswamy added the pr-awaiting-review PR is waiting for code review label Dec 7, 2018

marcoabreu added pr-work-in-progress PR is still work in progress and removed pr-awaiting-review PR is waiting for code review labels Jan 3, 2019

stsukrov reviewed Jan 7, 2019

View reviewed changes

src/mxfeatures.cc Outdated Show resolved Hide resolved

stsukrov reviewed Jan 7, 2019

View reviewed changes

src/mxfeatures.cc Outdated Show resolved Hide resolved

stsukrov reviewed Jan 7, 2019

View reviewed changes

src/mxfeatures.cc Outdated Show resolved Hide resolved

include/mxnet/mxfeatures.h Show resolved Hide resolved

lebeg reviewed Jan 7, 2019

View reviewed changes

src/mxfeatures.cc Outdated Show resolved Hide resolved

src/mxfeatures.cc Outdated Show resolved Hide resolved

src/mxfeatures.cc Outdated Show resolved Hide resolved

szha reviewed Jan 7, 2019

View reviewed changes

include/mxnet/mxfeatures.h Outdated Show resolved Hide resolved

TaoLv reviewed Jan 8, 2019

View reviewed changes

include/mxnet/mxfeatures.h Outdated Show resolved Hide resolved

larroy force-pushed the feature_discovery branch from 47f4d56 to 07d19a5 Compare January 8, 2019 15:40

larroy changed the title ~~[WIP] Prototype for runtime feature detection~~ [WIP] Runtime feature detection Jan 8, 2019

larroy force-pushed the feature_discovery branch 3 times, most recently from cadf83e to 7aff860 Compare January 9, 2019 00:53

larroy changed the title ~~[WIP] Runtime feature detection~~ Runtime feature detection Jan 9, 2019

marcoabreu added pr-awaiting-review PR is waiting for code review and removed pr-work-in-progress PR is still work in progress labels Jan 9, 2019

larroy force-pushed the feature_discovery branch from 6eee62e to 061d81b Compare January 9, 2019 19:30

larroy and others added 12 commits January 16, 2019 14:43

Prototype for runtime feature detection

ff109f5

Includes from diamond to quotes

5ebc7a2

Add CPU feature and BLAS flavour flags

30f057f

Add BLAS flavour and CPU SSE and AVX flags

e9eff40

MXNET_USE_LAPACK

2e60d23

Fix C++ linting errors

d913033

Expose runtime feature detection in the public C API and in the Pytho…

939d76c

…n API

Refactor Storage -> FeatureSet

80ae05e

Refine documentation

c6bdb54

Add failure case

a27af10

Fix pylint

799a567

Address CR comments

ba356cf

larroy force-pushed the feature_discovery branch from 7d77150 to ba356cf Compare January 16, 2019 13:43

apache deleted a comment from codecov-io Jan 16, 2019

marcoabreu added pr-awaiting-merge Review and CI is complete. Ready to Merge and removed pr-awaiting-review PR is waiting for code review labels Jan 17, 2019

aaronmarkham reviewed Jan 17, 2019

View reviewed changes

aaronmarkham merged commit 692a24a into apache:master Jan 21, 2019

szha reviewed Jan 22, 2019

View reviewed changes

python/mxnet/mxfeatures.py Show resolved Hide resolved

szha reviewed Jan 22, 2019

View reviewed changes

python/mxnet/mxfeatures.py Show resolved Hide resolved

szha reviewed Jan 22, 2019

View reviewed changes

python/mxnet/mxfeatures.py Show resolved Hide resolved

larroy mentioned this pull request Jan 23, 2019

Addresses comments in runtime feature discovery API #13964

Merged

5 tasks

iblislin mentioned this pull request Jan 25, 2019

Julia: add binding for runtime feature detection #13992

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Runtime feature detection #13549

Runtime feature detection #13549

larroy commented Dec 5, 2018 •

edited

Loading

Roshrini commented Dec 18, 2018

larroy commented Dec 18, 2018

Roshrini commented Jan 3, 2019

stsukrov Jan 7, 2019

larroy Jan 7, 2019

stsukrov Jan 7, 2019

stsukrov Jan 7, 2019

larroy Jan 8, 2019

stsukrov Jan 8, 2019

lebeg commented Jan 7, 2019

pengzhao-intel commented Jan 8, 2019

larroy commented Jan 9, 2019

larroy commented Jan 9, 2019

larroy commented Jan 17, 2019

aaronmarkham left a comment

larroy commented Jan 18, 2019

aaronmarkham commented Jan 18, 2019

larroy commented Jan 18, 2019

Runtime feature detection #13549

Runtime feature detection #13549

Conversation

larroy commented Dec 5, 2018 • edited Loading

Description

Checklist

Essentials

Changes

Comments

Roshrini commented Dec 18, 2018

larroy commented Dec 18, 2018

Roshrini commented Jan 3, 2019

stsukrov Jan 7, 2019

Choose a reason for hiding this comment

larroy Jan 7, 2019

Choose a reason for hiding this comment

stsukrov Jan 7, 2019

Choose a reason for hiding this comment

stsukrov Jan 7, 2019

Choose a reason for hiding this comment

larroy Jan 8, 2019

Choose a reason for hiding this comment

stsukrov Jan 8, 2019

Choose a reason for hiding this comment

lebeg commented Jan 7, 2019

pengzhao-intel commented Jan 8, 2019

larroy commented Jan 9, 2019

larroy commented Jan 9, 2019

larroy commented Jan 17, 2019

aaronmarkham left a comment

Choose a reason for hiding this comment

larroy commented Jan 18, 2019

aaronmarkham commented Jan 18, 2019

larroy commented Jan 18, 2019

larroy commented Dec 5, 2018 •

edited

Loading